<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.html">engines</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html">assistants</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.assistants.cannedQueries.html">cannedQueries</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, cannedQueryId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a CannedQuery.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a CannedQuery.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a CannedQuery.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all CannedQuerys under an Assistant.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a CannedQuery.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, cannedQueryId=None, x__xgafv=None)</code>
  <pre>Creates a CannedQuery.

Args:
  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
  &quot;defaultTexts&quot;: { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
    &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
    &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
      { # A suggested prompt for the canned query.
        &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
      },
    ],
    &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
  },
  &quot;displayName&quot;: &quot;A String&quot;, # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
  &quot;enabled&quot;: True or False, # Whether this canned query is enabled.
  &quot;googleDefined&quot;: True or False, # Output only. Whether this is a Google-defined, read-only canned query.
  &quot;localizedTexts&quot;: { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
    &quot;a_key&quot;: { # The text pieces for the canned query, which can be localized.
      &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
      &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
        { # A suggested prompt for the canned query.
          &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
        },
      ],
      &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
  &quot;requiredCapabilities&quot;: [ # Optional. The capabilities the Assistant needs to have to use this canned query.
    { # Capability of an assistant needed to use this canned query.
      &quot;actionName&quot;: &quot;A String&quot;, # The name of the action that the Assistant needs to have set up to use this canned query.
    },
  ],
}

  cannedQueryId: string, Required. The ID to use for the canned query, which will become the final component of the canned query&#x27;s resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
  &quot;defaultTexts&quot;: { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
    &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
    &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
      { # A suggested prompt for the canned query.
        &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
      },
    ],
    &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
  },
  &quot;displayName&quot;: &quot;A String&quot;, # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
  &quot;enabled&quot;: True or False, # Whether this canned query is enabled.
  &quot;googleDefined&quot;: True or False, # Output only. Whether this is a Google-defined, read-only canned query.
  &quot;localizedTexts&quot;: { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
    &quot;a_key&quot;: { # The text pieces for the canned query, which can be localized.
      &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
      &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
        { # A suggested prompt for the canned query.
          &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
        },
      ],
      &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
  &quot;requiredCapabilities&quot;: [ # Optional. The capabilities the Assistant needs to have to use this canned query.
    { # Capability of an assistant needed to use this canned query.
      &quot;actionName&quot;: &quot;A String&quot;, # The name of the action that the Assistant needs to have set up to use this canned query.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a CannedQuery.

Args:
  name: string, Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a CannedQuery.

Args:
  name: string, Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
  &quot;defaultTexts&quot;: { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
    &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
    &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
      { # A suggested prompt for the canned query.
        &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
      },
    ],
    &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
  },
  &quot;displayName&quot;: &quot;A String&quot;, # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
  &quot;enabled&quot;: True or False, # Whether this canned query is enabled.
  &quot;googleDefined&quot;: True or False, # Output only. Whether this is a Google-defined, read-only canned query.
  &quot;localizedTexts&quot;: { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
    &quot;a_key&quot;: { # The text pieces for the canned query, which can be localized.
      &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
      &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
        { # A suggested prompt for the canned query.
          &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
        },
      ],
      &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
  &quot;requiredCapabilities&quot;: [ # Optional. The capabilities the Assistant needs to have to use this canned query.
    { # Capability of an assistant needed to use this canned query.
      &quot;actionName&quot;: &quot;A String&quot;, # The name of the action that the Assistant needs to have set up to use this canned query.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all CannedQuerys under an Assistant.

Args:
  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
  filter: string, Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true`
  pageSize: integer, Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
  pageToken: string, A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the CannedQueryService.ListCannedQueries method.
  &quot;cannedQueries&quot;: [ # The list of CannedQuerys matching the request.
    { # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
      &quot;defaultTexts&quot;: { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
        &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
        &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
          { # A suggested prompt for the canned query.
            &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
          },
        ],
        &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
      },
      &quot;displayName&quot;: &quot;A String&quot;, # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
      &quot;enabled&quot;: True or False, # Whether this canned query is enabled.
      &quot;googleDefined&quot;: True or False, # Output only. Whether this is a Google-defined, read-only canned query.
      &quot;localizedTexts&quot;: { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
        &quot;a_key&quot;: { # The text pieces for the canned query, which can be localized.
          &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
          &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
            { # A suggested prompt for the canned query.
              &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
            },
          ],
          &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
        },
      },
      &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
      &quot;requiredCapabilities&quot;: [ # Optional. The capabilities the Assistant needs to have to use this canned query.
        { # Capability of an assistant needed to use this canned query.
          &quot;actionName&quot;: &quot;A String&quot;, # The name of the action that the Assistant needs to have set up to use this canned query.
        },
      ],
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as ListCannedQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates a CannedQuery.

Args:
  name: string, Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
  body: object, The request body.
    The object takes the form of:

{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
  &quot;defaultTexts&quot;: { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
    &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
    &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
      { # A suggested prompt for the canned query.
        &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
      },
    ],
    &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
  },
  &quot;displayName&quot;: &quot;A String&quot;, # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
  &quot;enabled&quot;: True or False, # Whether this canned query is enabled.
  &quot;googleDefined&quot;: True or False, # Output only. Whether this is a Google-defined, read-only canned query.
  &quot;localizedTexts&quot;: { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
    &quot;a_key&quot;: { # The text pieces for the canned query, which can be localized.
      &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
      &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
        { # A suggested prompt for the canned query.
          &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
        },
      ],
      &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
  &quot;requiredCapabilities&quot;: [ # Optional. The capabilities the Assistant needs to have to use this canned query.
    { # Capability of an assistant needed to use this canned query.
      &quot;actionName&quot;: &quot;A String&quot;, # The name of the action that the Assistant needs to have set up to use this canned query.
    },
  ],
}

  updateMask: string, The list of fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
  &quot;defaultTexts&quot;: { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
    &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
    &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
      { # A suggested prompt for the canned query.
        &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
      },
    ],
    &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
  },
  &quot;displayName&quot;: &quot;A String&quot;, # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
  &quot;enabled&quot;: True or False, # Whether this canned query is enabled.
  &quot;googleDefined&quot;: True or False, # Output only. Whether this is a Google-defined, read-only canned query.
  &quot;localizedTexts&quot;: { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
    &quot;a_key&quot;: { # The text pieces for the canned query, which can be localized.
      &quot;prefix&quot;: &quot;A String&quot;, # Optional. The prefix that `suggested_prompts` should start with.
      &quot;suggestedPrompts&quot;: [ # Required. The prompts the canned query will offer to the user.
        { # A suggested prompt for the canned query.
          &quot;promptText&quot;: &quot;A String&quot;, # Required. The text of the suggested prompt.
        },
      ],
      &quot;title&quot;: &quot;A String&quot;, # Required. The title that is for the end user.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
  &quot;requiredCapabilities&quot;: [ # Optional. The capabilities the Assistant needs to have to use this canned query.
    { # Capability of an assistant needed to use this canned query.
      &quot;actionName&quot;: &quot;A String&quot;, # The name of the action that the Assistant needs to have set up to use this canned query.
    },
  ],
}</pre>
</div>

</body></html>